RimuHosting's REST-ful Resources Reference

Path: / r / orders / order-{order-oid}-{domain} / vps / running-state

Change the running state to reboot a VPS.  For example, set it to 'RUNNING' if you want to start a stopped VPS (else does nothing).  e.g. to 'RESTARTING' if you wish to issue a reboot.  e.g. 'POWERCYCLING' to kill the VPS and restart it.  Setting a 'NOTRUNNING' state is currently not supported.  Since we are attempting to create a REST-ful API we are trying to 'verb' URIs like '/reboot'.

Path parameters:
order-oid ([0-9]+) - The id of the order and a domain name.  The domain name is not used in the lookup (we rely solely on the order oid) but the name makes the uri more user-friendly.  The order oid is immuatable.  It won't change.  Even if you rename the server.  So it makes a good id.
domain ([^;/]*) - This parameter is ignored.  But having it makes the urls a little more recognizable.  Typically the VPS domain name is inserted here.

Resource Methods
Method Summary
NameDescription
PUT /r/orders/order-{order-oid}-{domain}/vps/running-stateChange the running state to reboot a VPS.  For example, set it to 'RUNNING' if you want to start a stopped VPS (else does nothing).  e.g.

Method Detail

PUT /r/orders/order-{order-oid}-{domain}/vps/running-state

Change the running state to reboot a VPS.  For example, set it to 'RUNNING' if you want to start a stopped VPS (else does nothing).  e.g. to 'RESTARTING' if you wish to issue a reboot.  e.g. 'POWERCYCLING' to kill the VPS and restart it.  Setting a 'NOTRUNNING' state is currently not supported.  Since we are attempting to create a REST-ful API we are trying to 'verb' URIs like '/reboot'.

HTTP Example:
PUT /r/orders/order-{order-oid}-{domain}/vps/running-state
API Example:

JAXRSVPS.doReboot({'order-oid': /* order_oid The id of the order and a domain name.  The domain name is not used in the lookup (we rely solely on the order oid) but the name makes the uri more user-friendly.  The order oid is immuatable.  It won't change.  Even if you rename the server.  So it makes a good id. */,
  'domain': /* domain This parameter is ignored.  But having it makes the urls a little more recognizable.  Typically the VPS domain name is inserted here. */,
  '$entity': /* Change the running state to reboot a VPS.  For example, set it to 'RUNNING' if you want to start a stopped VPS (else does nothing).  e.g. */});

Input:
RunningStateChangeRequest
Output:
PutRunningStateResponse